vcJogInfo

vcJogInfo is an event listener for an interactive object defined by Jog Info behavior.

See in: Overview

Module: vcBehaviors

Parent: vcBehavior

Children -

Referenced by: -

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
endInteract	None	None	Stops the interact operation. Following interact calls will be ignored. Parameters: None Returns: None
interact	Boolean	vcVector hitPos	' This applies the given position vector to the jog info and See more does the actual interaction/jogging. The vector is given in world coordinates. Parameters: hitPos (vcVector): Current "cursor/pointer" World position as jog target. Returns: bool: True on success False otherwise.
startInteract	Boolean	vcVector hitPos	Initializes interact/jogging operation by defining a position vector where the interaction starts, See more that is a reference starting location in the world coordinate system. Parameters: hitPos (vcVector): Initial "cursor/pointer" World position. Returns: bool: True on success False otherwise.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnInteract	vcJogInfo jogInfo, vcJogInfoCursorAction action	Triggered when user interaction occurs with an object defined by a Jog Info behavior. See more Parameters: jogInfo (vcJogInfo): Jog info which triggered the event. action (vcJogInfoCursorAction): Cursor action which caused the event.